Legrand / Raritan Xerus™ JSON-RPC API for Remote Access Devices like KX4-101, KX3G2
Loading...
Searching...
No Matches
radm::AutoScan Interface Reference

Classes

struct  NfsStatusChangedEvent
 Event: NFS server status has changed. More...
struct  Settings
struct  SettingsChangedEvent
 Event: Settings have changed. More...

Public Types

enum  NfsStatus {
  INACTIVE , RESOLVING , MOUNTING , MOUNTED ,
  SUSPENDED , FAILED
}

Public Member Functions

Settings getSettings ()
 Get settings.
int setSettings (in Settings settings)
 Set settings.
NfsStatus getNfsStatus ()
 Get NFS server status.

Public Attributes

constant int ERR_INVALID_ARGUMENT = 1
constant int ERR_TIER_MODE_CONFLICT = 2
 Auto-scan can not be enabled while tiering mode is active.

Detailed Description

Definition at line 8 of file AutoScan.idl.

Member Enumeration Documentation

◆ NfsStatus

Enumerator
INACTIVE 

NFS share is inactive and not mounted.

RESOLVING 

Resolving NFS server host name.

MOUNTING 

Mounting NFS server share.

MOUNTED 

Mounted NFS server share.

SUSPENDED 

NFS share is suspended after being restarted after failure.

FAILED 

Connection to NFS share has failed.

Definition at line 12 of file AutoScan.idl.

Member Function Documentation

◆ getNfsStatus()

NfsStatus radm::AutoScan::getNfsStatus ( )

Get NFS server status.

Returns
NFS server status

◆ getSettings()

Settings radm::AutoScan::getSettings ( )

Get settings.

Returns
Settings

◆ setSettings()

int radm::AutoScan::setSettings ( in Settings settings)

Set settings.

Parameters
settingsNew settings
Returns
0 on success
1 if any setting was invalid

Member Data Documentation

◆ ERR_INVALID_ARGUMENT

constant int radm::AutoScan::ERR_INVALID_ARGUMENT = 1

Definition at line 9 of file AutoScan.idl.

◆ ERR_TIER_MODE_CONFLICT

constant int radm::AutoScan::ERR_TIER_MODE_CONFLICT = 2

Auto-scan can not be enabled while tiering mode is active.

Definition at line 10 of file AutoScan.idl.


The documentation for this interface was generated from the following file: